.TH "C:/Users/Matt/Documents/School/Robotics/zebulon/v2/vision/ext/SIFT/minpq.h" 3 "13 Oct 2009" "Version 2" "zebulon" \" -*- nroff -*-
.ad l
.nh
.SH NAME
C:/Users/Matt/Documents/School/Robotics/zebulon/v2/vision/ext/SIFT/minpq.h \- 
.SH SYNOPSIS
.br
.PP
\fC#include <stdlib.h>\fP
.br

.SS "Classes"

.in +1c
.ti -1c
.RI "struct \fBpq_node\fP"
.br
.ti -1c
.RI "struct \fBmin_pq\fP"
.br
.in -1c
.SS "Defines"

.in +1c
.ti -1c
.RI "#define \fBMINPQ_INIT_NALLOCD\fP   512"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "struct \fBmin_pq\fP * \fBminpq_init\fP ()"
.br
.ti -1c
.RI "int \fBminpq_insert\fP (struct \fBmin_pq\fP *\fBmin_pq\fP, void *data, int key)"
.br
.ti -1c
.RI "void * \fBminpq_get_min\fP (struct \fBmin_pq\fP *\fBmin_pq\fP)"
.br
.ti -1c
.RI "void * \fBminpq_extract_min\fP (struct \fBmin_pq\fP *\fBmin_pq\fP)"
.br
.ti -1c
.RI "void \fBminpq_release\fP (struct \fBmin_pq\fP **\fBmin_pq\fP)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Functions and structures for implementing a minimizing priority queue.
.PP
Copyright (C) 2006 Rob Hess <hess@eecs.oregonstate.edu> 
.PP
\fBVersion:\fP
.RS 4
1.1.1-20070913 
.RE
.PP

.SH "Function Documentation"
.PP 
.SS "void* minpq_extract_min (struct \fBmin_pq\fP * min_pq)"Removes and returns the element of a minimizing priority queue with the smallest key.
.PP
\fBParameters:\fP
.RS 4
\fI\fBmin_pq\fP\fP a minimizing priority queue
.RE
.PP
\fBReturns:\fP
.RS 4
Returns the element of \fI\fBmin_pq\fP\fP with the smallest key of NULL if \fI\fBmin_pq\fP\fP is empty 
.RE
.PP

.SS "void* minpq_get_min (struct \fBmin_pq\fP * min_pq)"Returns the element of a minimizing priority queue with the smallest key without removing it from the queue.
.PP
\fBParameters:\fP
.RS 4
\fI\fBmin_pq\fP\fP a minimizing priority queue
.RE
.PP
\fBReturns:\fP
.RS 4
Returns the element of \fI\fBmin_pq\fP\fP with the smallest key or NULL if \fI\fBmin_pq\fP\fP is empty 
.RE
.PP

.SS "struct \fBmin_pq\fP* minpq_init ()\fC [read]\fP"Creates a new minimizing priority queue. 
.SS "int minpq_insert (struct \fBmin_pq\fP * min_pq, void * data, int key)"Inserts an element into a minimizing priority queue.
.PP
\fBParameters:\fP
.RS 4
\fI\fBmin_pq\fP\fP a minimizing priority queue 
.br
\fIdata\fP the data to be inserted 
.br
\fIkey\fP the key to be associated with \fIdata\fP 
.RE
.PP
\fBReturns:\fP
.RS 4
Returns 0 on success or 1 on failure. 
.RE
.PP

.SS "void minpq_release (struct \fBmin_pq\fP ** min_pq)"De-allocates the memory held by a minimizing priorioty queue
.PP
\fBParameters:\fP
.RS 4
\fI\fBmin_pq\fP\fP pointer to a minimizing priority queue 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for zebulon from the source code.
